<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>The MongoRegex class</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="mongodate.tostring.html">« MongoDate::__toString</a></li>
      <li style="float: right;"><a href="mongoregex.construct.html">MongoRegex::__construct »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="mongo.types.html">Types</a></li>
    <li>The MongoRegex class</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="class.mongoregex" class="reference">

 <h1 class="title">The MongoRegex class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL mongo &gt;=0.8.1)</p>

  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">This extension that defines this class
is deprecated. Instead, the <a href="" class="link">MongoDB</a> extension should be used.
Alternatives to this class include:</p>
   <ul class="simplelist">
    <li class="member"><strong class="classname">MongoDB\BSON\Regex</strong></li>
   </ul>
  </div>


  <div class="section" id="mongoregex.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    This class can be used to create regular expressions.  Typically, these
    expressions will be used to query the database and find matching strings.
    More unusually, they can be saved to the database and retrieved.
   </p>
   <p class="para">
    Regular expressions consist of four parts. First a <code class="literal">/</code>
    as starting delimiter, then the pattern, another <code class="literal">/</code> 
    and finally a string containing flags.
   </p>
   <p class="para">
    <div class="example" id="example-175">
     <p><strong>Example #1 Regular expression pattern</strong></p>
      <div class="example-contents screen">
<div class="cdata"><pre>
/pattern/flags
</pre></div>
      </div>
    </div>
   </p>
   <p class="para">
    MongoDB recognizes six regular expression flags:
   </p>
   <ul class="itemizedlist">
    <li class="listitem">
     <p class="para">
      <code class="literal">i</code>: Case insensitive
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">m</code>: Multiline
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">x</code>: Can contain comments
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">l</code>: locale
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">s</code>: dotall, &quot;.&quot; matches everything, including newlines
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">u</code>: match unicode
     </p>
    </li>
   </ul>
  </div>


  <div class="section" id="mongoregex.synopsis">
   <h2 class="title">Class synopsis</h2>


   <div class="classsynopsis">
    <div class="ooclass"></div>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <strong class="classname">MongoRegex</strong>
     </span>
     {</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Fields */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <span class="type">string</span>
      <var class="varname">$<var class="varname">regex</var></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="type">string</span>
      <var class="varname">$<var class="varname">flags</var></var>;</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="mongoregex.construct.html" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="mongoregex.tostring.html" class="methodname">__toString</a></span>(): <span class="type">string</span></div>

   }</div>


  </div>

 </div>

 















<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongoregex.construct.html">MongoRegex::__construct</a> — Creates a new regular expression</li><li><a href="mongoregex.tostring.html">MongoRegex::__toString</a> — A string representation of this regular expression</li></ul>
</div>
</div></div></body></html>